API keys and webhooks

API keys and webhooks are for a server you control. The screen says: Never use API keys in browser or frontend code. This menu is shown to a super admin.

Who can use this. Super admin. The menu is Developers, then API Keys or Webhooks. Client API is a separate super-admin menu for OAuth clients.

Before you start. You need a server that can store the secret. Decide the name, the allowed domain or IP if you use those limits, and the events you will receive.

Steps

  1. Open Developers, API Keys.
  2. Create a key, name it, and set the domain or IP limits the form shows.
  3. Copy the secret when it is shown. If the list is empty, it says No API keys have been created yet.
  4. Open Developers, Webhooks.
  5. Add the endpoint URL and choose the events. Reveal the signing secret only when you can store it.
  6. Rotate or revoke a key from the key list when it is no longer safe. Revoking stops later API calls that use it. It does not refund payments.
What you seeMeaningWhat happens next
API keyAuthenticates the merchant API. Keys use a secret prefix.A key in a web page can be stolen. Keep it on the server.
IP or domain limitOptional restriction on the key.A call from another IP is rejected.
Webhook endpointYour URL for events.RapidCents does not browse this URL in the dashboard as a delivery log in the article you are reading. Verify on your server.
Signing secretLets you verify the webhook.Treat it like a password.

After you save or submit. Creating a key does not create a payment. The first API charge appears in Transaction History with source API.

Example. Example only: Example Cafe creates a key named Store server and stores it on a server, not in the shop website. A fictional API sale of 12.00 shows in Transaction History as API. A key pasted into a public page would be unsafe, so Cafe revokes that fictional key and creates another.

Troubleshooting

  • You cannot see Developers. The menu is limited to super admin.
  • The API returns not authorized. The key is revoked, expired, or the IP is not allowed. The dashboard also returns You are not authorized to access this resource when a signed-in user lacks a permission.
  • You wanted a WooCommerce plugin install. That install is not a page in this dashboard. Use the payment link, the API, or the plugin's own install guide.

Related

Found this helpful?

( 1 out of 1 found helpful )

Still no luck? we can help!

Submit a ticket and we’ll get back to you as soon as possible.

Support Chat Available
Account login is required to start, please login to your account to proceed.